home *** CD-ROM | disk | FTP | other *** search
/ Business Shareware / Business Shareware.iso / start / archive / uudo12 / uudo12.doc < prev   
Text File  |  1993-03-25  |  7KB  |  153 lines
  1. UUDO v1.2  (c) 1993, Ryan Kim.  -  Multi-file/Multi-part uudecoder
  2.  
  3.  
  4. DESCRIPTION:
  5.  
  6. - UUDO is an "Smart" uudecoder for DOS for generating binary files from
  7.   uuencoded files that may be split into many parts.
  8. - The only requirement is that, for multi-part files, each uuencoded part must
  9.   be in its own file and has a "Subject: ..." line indicating the part number.
  10.   (Assuming the uuencoded files are coming from the Usenet:
  11.   This can be done easily by issuing "s" command without filename inside rn.
  12.   Make sure to start rn with -N and -/ options.)
  13. - UUDO supports the subject line with part numbers in the format of "xx/yy" or
  14.   "xx of yy", where xx is the part number, and the yy is the total part number.
  15.   If none of these is found, it is assumed that the file contains the entire
  16.   uuencoded text for a binary.
  17. - If any error is found in generating a binary file, UUDO will copy all the
  18.   uuencoded part files for that binary to the error directory which must be
  19.   specified in the command line.
  20. - A report is generated describing which uuencoded texts were decoded into
  21.   which binary files.
  22.  
  23.  
  24. DISCLAIMER:
  25.  
  26. - This is a FREEWARE.  Although the program is copyrighted by me, Ryan Kim,
  27.   you're allowed to use, copy, and distribute this program for FREE
  28.   as long as nothing is modified in any way, this document is
  29.   always present with the program, and you're not gaining any profit
  30.   with this program.
  31. - There is no warranty whatsoever.  Use it at your own risk!
  32.  
  33. - Please read the section marked "FINAL NOTES" at the end of this document
  34.   for a small (non-obligatory) favour I ask for the users of UUDO program.
  35.  
  36.  
  37. QUICK START:
  38.  
  39. UUDO requires the input files (wildcards allowed) and the error directory.
  40. So something like "UUDO *. \" should work.
  41. Make sure each uuencoded part is in a separate file.
  42.  
  43.  
  44. HOW TO:
  45.  
  46. Typing UUDO by itself gives the following help screen:
  47.  
  48. UUDO v1.2  (c) 1993, Ryan Kim.  -  Multi-file/Multi-part uudecoder
  49.  
  50. Usage:  UUDO [/n] [/k] [/r1] [/r2] input_files error_directory
  51.              where /n:   No report file "UUDO.REP" generated
  52.                    /k:   Keep incomplete binary files
  53.                    /r1:  Relaxed format-checking level 1
  54.                    /r2:  Relaxed format-checking level 2 (See Doc)
  55.                    /s:   Smart (?) mode
  56.  
  57. 1. If you're getting the uuencoded files from the Usenet:
  58.    In 'rn', save each article in different files by doing, say, "1650-1759 s".
  59.    This will save different articles in files 1650, 1651, 1652, ..., 1759,
  60.    provided that you turned on -N and -/ switches in 'rn' command line.
  61. 2. Move these files to a DOS machine.  This may be either in text or
  62.    binary mode file transfer.
  63. 3. Assuming you have a path to UUDO.EXE, or UUDO is available somewhere,
  64.    and all the above files are in the current directory:
  65.    Create a subdirectory called ERROR, from the current directory.
  66. 4. Type "UUDO *.* error"
  67.  
  68. Now, UUDO will extract all the binary files to the current directory.
  69. Any files that cannot be decoded properly will be copied to
  70. the "error" directory, you just created.
  71. UUDO will also create a file called "UUDO.REP" in the current directory
  72. and report which files are decoded to which.  This is very handy way of
  73. checking where the binaries came from and how UUDO read the subject line.
  74.  
  75. UUDO has a few options to accomodate some uuencoded files that may contain
  76. errors or may not use the standard uuencode format:
  77.  
  78. /k option:   By default, UUDO deletes any binary files that were not decoded
  79.              properly to the end.  If this option is specified, UUDO will keep
  80.              all the binary files with error, even though they're incomplete.
  81. /r1 option:  With this option, UUDO will not do most of the uuencode format
  82.              checking.  This is useful when the uuencoded file uses some
  83.              non-standard uuencode format and UUDO stops at certain line.
  84.              NOTE:  /r1 and /r2 options may generate incorrect binary file
  85.                     because many format checkings are not done.  Use these
  86.                     options only on files that UUDO has trouble decoding.
  87. /r2 option:  This option may be used when /r1 option generates the correct
  88.              binary file except the last few bytes.  Use this after you tried
  89.              /r1 option.  You may have to put all the parts together manually.
  90. If all these do not work, the uuencoded file probably contains
  91. some unrecoverable errors.  If you are _really_ desperate, you may try
  92. to concatenate all uuencoded parts together in a file (deleting all
  93. non-uuencoded texts) and use /r2 option, although, it may still not work.
  94.  
  95. UUDO uses two file names (which may be different) to indicate the name of
  96. the binary file.  The first is the name UUDO found in the subject line
  97. and the second is the name UUDO found in "begin xxx zzzz" line of
  98. the uuencoded text.  UUDO will use the first name until the real name
  99. (the second name) is found.
  100.  
  101. You can press ESC key at any time to stop UUDO.  There will be slight delay
  102. while UUDO finishes off its current operation.
  103.  
  104.  
  105. HISTORY:
  106.  
  107. v1.0     Initial Release to a few testers for some first-impressions.
  108. v1.1     The first general public release of UUDO!
  109.          Minor changes in command-line options and the document.
  110. v1.2     Asks if the user wants to overwrite the existing file or change
  111.          the filename.
  112.          Better algorithm in finding the part and total parts number
  113.          /s option (NOTE:  This option will be removed in the future!):
  114.          If /s is specified and there are additional files with the same name
  115.          and part number, you will be asked if UUDO should ignore them.
  116.          These are useful if there are several repost of the same parts.
  117.          Use this option with care because you could be ignoring files
  118.          that may be intended for different binary files.
  119.          This option will be removed in the future and UUDO will automatically
  120.          detect if the files are reposts or not.
  121.  
  122.  
  123. FUTURE WORKS
  124. I am currently extremely busy, but, when I find some time I'd like to do:
  125. - Automatic detection of redundant parts
  126. - Support of alt.binaries standard of multi-part file format
  127. - Include multi-part uuencode capability
  128. - Support for VAX uuencoded text
  129. - Smarter detection of parts (even with the same filenames... But how?)
  130.  
  131.  
  132. FINAL NOTES:
  133.  
  134. I wrote this program for my personal use (to save my precious time from
  135. looking through files, trying to fit pieces together, and decoding),
  136. and I hope you will find it useful also.
  137.  
  138. I'd like very much to know if you're using this program since this is,
  139. I believe, my first program that could be used widely around the world.
  140. I would appreciate it very much if you could drop me a line and tell me
  141. where you're from, and where you got this program (i.e. Usenet group name,
  142. FTP site name, BBS name, etc).  This is for some statistics for my personal
  143. use.  Don't worry, I won't sell your names to the junk-mail companies.  :-)
  144. Please also let me know if you want to receive future upgrades of UUDO
  145. by e-mail.
  146. Thanks!
  147.  
  148. I can be reached by e-mail at rkim@eecg.toronto.edu
  149.  
  150.  
  151.                                                        Ryan
  152.                                           from Scarborough, Ontario, CANADA
  153.